-
-
Notifications
You must be signed in to change notification settings - Fork 50
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(nuxt): Add deployment-platform flow with links to docs #747
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I checked the general flow of the wizard and I think it's good 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! I like the idea of having this deployment provider section. Maybe something we can think of for more frameworks but it's certainly most relevant for Nuxt (and SolidStart in the future)
src/nuxt/nuxt-wizard.ts
Outdated
if (canImportSentryServerConfigFile) { | ||
msg += `\n\nAfter building your Nuxt app, you need to ${chalk.cyan( | ||
'--import', | ||
)} the Sentry server config file.\n\nFor more info see: ${chalk.cyan( | ||
'https://docs.sentry.io/platforms/javascript/guides/nuxt/install/cli-import/#initializing-sentry-with---import', | ||
)}`; | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
l: given that this is a pretty crucial step, I was thinking that we could make this a step that users have to confirm instead of showing this in the outro message.
So basically, print this message and make them confirm the step with an "Ok, I got it" or so. There's similar precedence for something like this in our source map wizard.
I'll leave this up to you though, so feel free to go with whatever you prefer.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, good idea! What if we (also?) opened up the docs for them with that link since it's pretty crucial that they read the info on there?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like it! I think it's most important to have this one extra step so that people actually read what the wizard tells them, before the outro message is printed. Asking about opening docs achieves this well. Thanks!
Co-authored-by: Lukas Stracke <[email protected]>
f80815a
to
31fa5d9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚢 it!
We now ask where users plan to deploy their app:
For Vercel and Netlify we configure top level import of the Sentry server config file and link to docs:
For other/none we instruct people at the end to
--import
their Sentry server config file and link to docs:This also improves the handling when a user's nuxt config can not be read. Instead of exiting the wizard, we continue and instruct people how to manually add it (already existed, but we bailed immediately after instructing).
Closes: #739